Conversation
Add a Pillow-based screenshot generator that renders Click help output as annotated terminal-style PNG images for use in the documentation. The renderer supports colored annotation boxes with labels that highlight different sections of CLI output (Usage, Options, Commands, etc.). All dependencies are pip-installable. Images are rendered at 2x scale for crisp display on high-DPI screens. A system monospace font is auto-detected on Linux, macOS, and Windows. Closes pallets#3081.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements the screenshot workflow described in #3081.
Adds a
docs/screenshots.pymodule that renders Click help output asannotated terminal-style PNG images using Pillow. The renderer:
Screenshot
Changes
docs/screenshots.py— New screenshot generator modulepyproject.toml— Addpillowtodocsdependency groupdocs/_static/cli-help-annotated.png— Generated screenshotdocs/quickstart.md— Add "Understanding the Help Output" sectionDesign Decisions
needed in CI, fully pip-installable.
to Pillow's built-in font if none found.
start_textprefixmatching to find line ranges, making them robust to output changes.
python docs/screenshots.py)rather than integrated as a Sphinx extension, keeping the build simple.
Closes #3081.